Class Bz2

Summary

Fully Qualified Name: Laminas\Filter\Compress\Bz2
Extends: AbstractCompressionAlgorithm

Description

Compression adapter for Bz2

Methods

Name Description Defined By
__construct() Class constructor Bz2
compress() Compresses the given content Bz2
decompress() Decompresses the given content Bz2
getArchive() Returns the set archive Bz2
getBlocksize() Returns the set blocksize Bz2
getOptions() Returns one or all set options AbstractCompressionAlgorithm
setArchive() Sets the archive to use for de-/compression Bz2
setBlocksize() Sets a new blocksize Bz2
setOptions() Sets all or one option AbstractCompressionAlgorithm
toString() Returns the adapter name Bz2

Method Details

__construct()

Class constructor

Parameter Name Type Description
$options null|array|\Traversable (Optional)

Returns:

compress()

Compresses the given content

Parameter Name Type Description
$content string

Returns: string

decompress()

Decompresses the given content

Parameter Name Type Description
$content string

Returns: string

getArchive()

Returns the set archive

Returns: string

getBlocksize()

Returns the set blocksize

Returns: int

getOptions()

Returns one or all set options

Parameter Name Type Description
$option string|null Option

Returns: mixed

setArchive()

Sets the archive to use for de-/compression

Parameter Name Type Description
$archive string Archive

Returns: self

setBlocksize()

Sets a new blocksize

Parameter Name Type Description
$blocksize int

Returns: self

setOptions()

Sets all or one option

Parameter Name Type Description
$options array

Returns: self

toString()

Returns the adapter name

Returns: string

Top